org.springframework.core.codec

Class ResourceRegionEncoder

java.lang.Object

org.springframework.core.codec.AbstractEncoder<ResourceRegion>

org.springframework.core.codec.ResourceRegionEncoder

All Implemented Interfaces:

Encoder<ResourceRegion>

public class ResourceRegionEncoder
extends AbstractEncoder<ResourceRegion>

Encoder for ResourceRegions.

Since:

5.0

Author:

Brian Clozel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BOUNDARY_STRING_HINT
private int	bufferSize
static int	DEFAULT_BUFFER_SIZE

Constructor Summary

Constructors

Constructor and Description
ResourceRegionEncoder()
ResourceRegionEncoder(int bufferSize)

Method Summary

Modifier and Type	Method and Description
boolean	canEncode(ResolvableType elementType, MimeType mimeType) Whether the encoder supports the given source element type and the MIME type for the output stream.
private java.util.OptionalLong	contentLength(Resource resource) Determine, if possible, the contentLength of the given resource without reading it.
<any>	encode(<any> inputStream, DataBufferFactory bufferFactory, ResolvableType elementType, MimeType mimeType, java.util.Map<java.lang.String,java.lang.Object> hints) Encode a stream of Objects of type T into a DataBuffer output stream.
private byte[]	getAsciiBytes(java.lang.String in)
private byte[]	getContentRangeHeader(ResourceRegion region)
private <any>	getRegionPrefix(DataBufferFactory bufferFactory, byte[] startBoundary, byte[] contentType, ResourceRegion region)
private <any>	getRegionSuffix(DataBufferFactory bufferFactory, java.lang.String boundaryString)
private <any>	writeResourceRegion(ResourceRegion region, DataBufferFactory bufferFactory)

Methods inherited from class org.springframework.core.codec.AbstractEncoder

getEncodableMimeTypes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.core.codec.Encoder

getContentLength

Field Detail

DEFAULT_BUFFER_SIZE

public static final int DEFAULT_BUFFER_SIZE

See Also:

Constant Field Values

BOUNDARY_STRING_HINT

public static final java.lang.String BOUNDARY_STRING_HINT

bufferSize

private final int bufferSize

Constructor Detail

ResourceRegionEncoder

public ResourceRegionEncoder()

ResourceRegionEncoder

public ResourceRegionEncoder(int bufferSize)

Method Detail

canEncode

public boolean canEncode(ResolvableType elementType,
                         @Nullable
                         MimeType mimeType)

Description copied from interface: Encoder

Whether the encoder supports the given source element type and the MIME type for the output stream.

Specified by:

canEncode in interface Encoder<ResourceRegion>

Overrides:

canEncode in class AbstractEncoder<ResourceRegion>

Parameters:

elementType - the type of elements in the source stream

mimeType - the MIME type for the output stream (can be null if not specified)

Returns:

true if supported, false otherwise

encode

public <any> encode(<any> inputStream,
                    DataBufferFactory bufferFactory,
                    ResolvableType elementType,
                    @Nullable
                    MimeType mimeType,
                    @Nullable
                    java.util.Map<java.lang.String,java.lang.Object> hints)

Description copied from interface: Encoder

Encode a stream of Objects of type T into a DataBuffer output stream.

Parameters:

inputStream - the input stream of Objects to encode. If the input should be encoded as a single value rather than as a stream of elements, an instance of Mono should be used.

bufferFactory - for creating output stream DataBuffer's

elementType - the expected type of elements in the input stream; this type must have been previously passed to the Encoder.canEncode(org.springframework.core.ResolvableType, org.springframework.util.MimeType) method and it must have returned true.

mimeType - the MIME type for the output stream (optional)

hints - additional information about how to do encode

Returns:

the output stream

getRegionPrefix

private <any> getRegionPrefix(DataBufferFactory bufferFactory,
                              byte[] startBoundary,
                              byte[] contentType,
                              ResourceRegion region)

writeResourceRegion

private <any> writeResourceRegion(ResourceRegion region,
                                  DataBufferFactory bufferFactory)

getRegionSuffix

private <any> getRegionSuffix(DataBufferFactory bufferFactory,
                              java.lang.String boundaryString)

getAsciiBytes

private byte[] getAsciiBytes(java.lang.String in)

getContentRangeHeader

private byte[] getContentRangeHeader(ResourceRegion region)

contentLength

private java.util.OptionalLong contentLength(Resource resource)

Determine, if possible, the contentLength of the given resource without reading it.

Parameters:

resource - the resource instance

Returns:

the contentLength of the resource